home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / racal135.zip / RACALL.DOC < prev    next >
Text File  |  1991-07-16  |  20KB  |  432 lines
  1.                    RACALL v1.35  Copyright 1990 Kent W. Timm
  2.  
  3. Introduction
  4. ------------
  5.           RACALL creates BBS statistics bulletins for RemoteAccess.
  6.          It has been tested on RA v1.01+.  The version of RACALL in this
  7.          package is v1.35, it has limited (no ANSI) output until registered.
  8.          But NO stats functions are removed nor crippled, there are all
  9.          there, but not in color until registerd.  There are a couple of
  10.          "bonus" features when registered, but they are not directly part
  11.          of the statistics make process.
  12.  
  13.          You are required to Register RACALL after a 21 trial, otherwise,
  14.          RACALL will start complaining, making noise, and display a trial
  15.          use over message in the bulletins after 21 days.
  16.  
  17. Why did I write RaCall?
  18. -----------------------
  19.          That goes back to the QBBS days, I couldn't find a good statistics
  20.          program for QBBS, so I made QCall.  It stated as such a tiny
  21.          thing (under 10K of code), that I kept adding things.  When I
  22.          swithed to RA, I rebuilt QCall and created RaCall.  Take a look at
  23.          the history the end of the docs for all the things added over
  24.          the past year or so.
  25.  
  26.               Both RaCall anf QCall were never planned to be available to
  27.          the public.  But I decided maybe somebody else might like it too.
  28.          Since them I've added many things to RaCall to be able to handle
  29.          most any RA system.  Many of these features I have no use for myself!
  30.          Most of these added goodies were suggested to me, and within a week
  31.          or so added.  The "Rename Log" feature was added within 12 hours
  32.          of being suggested to me! I've killed bugs with 1 hour a couple times!
  33.          Of course I can't be that fast all the time, but when something needs
  34.          fixxing, I do it as fast as possible.
  35.  
  36.  
  37. Legal
  38. -----
  39.          Boring, but needed:
  40.  
  41.               You MUST Register RACALL if you use it beyond the 21 day trial.
  42.          If you do not Register after 21 days, you are required to stop
  43.          using RaCall in any way.
  44.  
  45.               As soon as the Registered RACALL is in place, it will
  46.          stop beeping when running, and make ANSI color versions of all
  47.          RaCall's bulletins.
  48.  
  49.          **  RACALL comes with no warranty of any kind, no responsibility
  50.          or liability is taken for RACALL's use or it actions.
  51.          (they should make a rubber stamp for docs saying that..:-)
  52.  
  53.          **  RACALL is NOT to be placed on any Media for sale,
  54.          including, but not limited to CD-ROMs, tape drive, or disk by
  55.          software distribution services/companies or anyone else
  56.          without written permission and license from the author.
  57.          No fee may be charged for RACALL in any way, except by the
  58.          author, Kent W. Timm.
  59.  
  60.  
  61. REGISTERING RACALL
  62. ------------------
  63.               To Register RACALL, simply send your request form in
  64.          along with $10* to register it.  You will be sent a PassKey
  65.          to be put in Racall.cfg.  Once the PassKey is in place RaCall
  66.          will start making ANSI files and go beyond the 21 day trial.
  67.          (* see order form for full details)
  68.  
  69.               I don't think $10 is much to ask for considering the countless
  70.          hours I've spent fine tuning this program.  I've added MANY
  71.          features I personally have no use for, to make it fit just about
  72.          any setup.
  73.          (and I got to pay for getting the [bleep] hard drive replaced)
  74.  
  75.          To fill-out and print a registeration form run: RACALL /FORM,
  76.          or use ORDER.FRM included in this package.
  77.          Please use the /FORM option in RaCall if you can, that way it
  78.          will read the BBS Name and SysOp Name directly from the Config.Ra
  79.          preventing spelling/case errors.
  80.  
  81.          Send your request to Register to:
  82.  
  83.            Kent TIMM
  84.            907-1790 Eglinton Av. East
  85.            Toronto, Ontario
  86.            M4A 2T3
  87.  
  88. USING RACALL
  89. ------------
  90.               RACALL is designed to run as a event at any time.
  91.          It will look through the either OPUS or FD format RA.LOG and
  92.          compile the information found there.  It will then write to files
  93.          to disk that contain the following information:
  94.  
  95.          General Call Statistics.
  96.          Problem Call Statistics.
  97.          Message Statistics.
  98.          Conference Statistics. (message count entered in each area)
  99.          File Statistics (UL/DL)
  100.          Protocol Statistics.(count each UL/DL protocol that was used)
  101.          Percentages shown for several stats.
  102.          Who Called yesterday (during the last RA.LOG)
  103.          Top Callers+
  104.          Top Message Posters+
  105.          Top UpLoaders+
  106.          Top DownLoaders+
  107.  
  108.           + Top Users configured by sysop, (Top Ten, Fifteen, etc...)
  109.  
  110.          For a sample Bulletins see the files:
  111.           DAILY.ASC/ANS     Daily and System-to-Date
  112.           WHO.ASC/ANS       Who Called Yesterday
  113.           TOPUSERS.ASC/ANS  Top Ten Callers/Posters/ULers/DLers
  114.  
  115. RaCall.CFG
  116. ----------
  117.          RACALL needs a configuration file, this is called RACALL.CFG
  118.  
  119.          Starting with v1.10, RaCall has it's own built in
  120.          configuration program!  Run: RACALL /c
  121.          The /c MUST be lower case.  The configuration menu simple and
  122.          straight forward.  Be sure to enter Upper Case letters for
  123.          commands.  eg.: Y not y
  124.  
  125.          Do NOT edit RaCall.Cfg with anything but the built in config
  126.          program!  (RACALL /c)
  127.  
  128.          RACALL.CFG MUST have the following in the exact order shown
  129.          here.  There is a sample RACALL.CFG enclosed with this
  130.          package.
  131.  
  132.               The BBS name, SysOp name, path to Users.bbs, password tries,
  133.          exclude SysOp from lists are all read directly from the Config.Ra
  134.          file that is found by the SET RA=.  Message areas are all found
  135.          this way, saves a lot of set-up time and problems.
  136.  
  137.               While RA.LOG or whatever you named your log is found in
  138.           Config.Ra, if no path is set in Config.Ra it *must* be in RaCall.Cfg.
  139.           If you have the full path to Ra.Log in Config.Ra make sure the
  140.           path in RaCall.Cfg is empty.
  141.  
  142.               Display mode (3 in /c) is how the message areas will be listed.
  143.           1 = Full area name, one area per line
  144.           2 = Almost full area name, two per line (best bet)
  145.           3 = Short area name, 3 per line (area names should be short)
  146.           4 = n/a
  147.           5 = area numbers only, five per line (as in older versions)
  148.  
  149.               Display mode (H in /c) is the non-color bulletins.
  150.           0 = 8th bit use (as in older versions)
  151.           1 = 7bit only, stars (*) and dashes (-) replace codes 176 & 205
  152.           2 = neither 176/205 or star and dashes are used in header/frames.
  153.  
  154.               Your board's name will only be displayed when using the
  155.          Registered version.
  156.  
  157.          "TOP x" is for the top users lists, x being how many top users
  158.          (eg: top 10, 20...)
  159.          You can select to use either USERS.BBS or the logs for the Top Users
  160.          lists.  USERS.BBS will give lists from a total in it, while using
  161.          the log you can Reset TopUsers.  Good for once a month/year
  162.          Top User list, however you can use both.
  163.          If you use USERS.BBS the data file RaCall.USR is not required.
  164.  
  165.          The sorting process for the Top User list is a bit slow, but
  166.          works quite well, but if you want to disable this function
  167.          simply set the Output Path/filename for either of the two
  168.          Top User bulletins to 0 length.
  169.          (ie: what's in between the quotes> "")
  170.          BOTH regular and ANSI path/filename MUST be set to enable this
  171.          feature!
  172. PassKey
  173. -------
  174.               The PassKey enables the Registered RACALL.  When you
  175.          register you are sent a PassKey.  Put it in the RACALL.CFG
  176.          file as shown above, once in place RACALL switches into
  177.          Registered mode.  It will then make ANSI files, and run past
  178.          the 21 day trial.  NOTE: If you change your BBS's name you
  179.          must get a new pass key to match the new name!  There is a
  180.          small charge to have a new PassKey made. (see order form)
  181.  
  182.               Starting with v1.20, RaCall uses two PassKeys now.
  183.          
  184.          **   RACALL.CFG Must be in the default directory!
  185.  
  186.               RACALL will also create a file call RACALL.DAT.  This file
  187.          store the information the RACALL uses and update daily to
  188.          create the system to date bulletin.  Just leave this file
  189.          alone! RACALL knows what to do with it! Any changes to this
  190.          file will cause RACALL to abort or cause errors.  Also, RACALL
  191.          makes some changes to RACALL.CFG.  So don't worry about
  192.          seeing a new date/time on the file, it's just RaCall doing
  193.          it's job.
  194.  
  195.               Also, RACALL.USR is the data base for the Top Callers.
  196.          to start, it MUST be one line with only a "0" (no quotes).
  197.          After the first run RACALL will use it and update it as needed.
  198.          RACALL.USR is included in this package.
  199.          **********  DO NOT EDIT THIS FILE IN ANY WAY **********
  200.  
  201.               Be sure to remove, rename, or otherwise have in NEW
  202.          RA.LOG created daily (after EVERY run), otherwise RACALL
  203.          will RE-READ the log and artificially increase the statistics
  204.          of your board.  So, in your batch file have it get the old
  205.          RA.LOG out of the way so that RACALL won't go over the old
  206.          one again!
  207.  
  208.               Using the /r switch will do this for you!  After compiling
  209.          the log, the log will be ReName to he LAST DATE in the log.
  210.          Then a NEW RA.LOG will be made in the same format as the log just
  211.          processed.  This new log will have a Date Marker that will help
  212.          keeps dates in order. NOTE: The PATH for the renamed log must
  213.          be on the same drive!
  214.  
  215.               You can also create a new log with the Date Marker manually.
  216.          /1OPUS will make a OPUS log with Date Marker.
  217.          /1FD will make a FrontDoor log with Date Marker.
  218.          These are best for when you first set up RaCall.
  219.          * Warning: using either of the kill over write Ra.Log if it's still
  220.          there, it best to use the /r to rename instead since it get the
  221.          old log out of the way and starts the new log.
  222.  
  223.               RACALL is designed to run once a day, this is so the log
  224.          dates do not overlap.  If you run RACALL at another time, it
  225.          will count each date change, it will see two logs with the
  226.          same dates, one from the 24 hours just ending, and the same
  227.          date again at the beginning of the next log if would read the
  228.          next day.
  229. *****    A new log MUST be started after every RACALL run. *****
  230.  
  231. Exception File:
  232. ===============
  233.               This allows you to exclude shells (type 7) and exits (type 15)
  234.          from being included in door access count.  This is mainly for
  235.          Chat, external file, and other "doors" that you don't want RaCall to
  236.          count as doors.  This must be turn on in RACALL /c.
  237.  
  238.          RACALL.EXP can list up to 10 errorlevels or shell command lines.
  239.          Command line do not need to be the full command line used, but just
  240.          enought to be different then any other.  CASE (CAPS/lowers) MUST
  241.          match the menu command line, the line in RACALL.EXP must be the same
  242.          in the menu, but does not have to be the full command line.
  243.          c:\command.com /c program.exe   <<-in the menu
  244.          c:\command.com /c prog          <<-in RACALL.EXP would be a match
  245.          since the menus line matches the exception line up the the end of
  246.          the exception line.
  247.          Errorlevel exit:  Just put the errorlevel on the line, NO spaces
  248.          before or after.
  249.  
  250.          RACALL.EXP must be in place if the option <I> is on in RACALL /c
  251.          RACALL.EXP is not required if the exception option is not used.
  252.  
  253. COMMAND LINE OPTIONS:
  254. =====================
  255.          /c        Configure RACALL. No stats will be compiled.
  256.  
  257.          /r        Rename log to LAST date in log after processing.
  258.                    eg: RA.LOG becomes Oct05-90.LOG if October
  259.                    5, 1990 was that last date in log.
  260.                    This also make a new Ra.Log in the same format as just
  261.                    compiled with a Date Marker.
  262.                    * If the program is ran a second time during a day
  263.                    (log ending with same date) Oct05-90.LOG would be
  264.                    Oct05a90.LOG.
  265.  
  266.          /1OPUS    Starts a new OPUS style log with Date Marker.
  267.  
  268.          /1FD      Starts a new FrontDoor style log with Date Marker.
  269.  
  270.          /RTOP     Reset TOP USERS list.  No stats will be compiled.
  271.                    This could be a once a month event.
  272.                    [Registered Version ONLY!]
  273.  
  274.          /RDAT     Reset STATISTIC DATA. All old stats info is killed.
  275.                    No stats will be compiled.
  276.                    This could be a once a month event.
  277.                    [Registered Version ONLY!]
  278.  
  279.          /F....    RACALL /Ffd.log NEWU
  280.                    will take the FrontDoor style log found in FD.LOG
  281.                    and append it to the RA.LOG defined in RaCall.CFG,
  282.                    NEWU is placed as the program name as RA01 is for node 1.
  283.                    ^^^^-Can be anything as long as it is 4 letters/numbers
  284.                    and does NOT start with RA or XRS. Run after door that
  285.                    makes FrontDoor style logs.  Kills FD.LOG after converting.
  286.                    (For batch File/type 15 menu)
  287.                    [Register Version ONLY!]
  288.  
  289.          /S....    RACALL.EXE /Sfd.log NEWU CALLBACK.EXE
  290.                    Same as /F, but you call RACALL from type 7 menu option.
  291.                    CALLBACK.EXE is the name of the program RaCall is to
  292.                    shell to and run, after the program is done RaCall
  293.                    converts the FD.LOG and exits back to the BBS.
  294.                    (For shell/type 7 menu option)
  295.                    [Registered Version ONLY!]
  296.  
  297.          /FORM     Fill out and print registeration form.
  298.  
  299. *****    NOTE:     Only ONE command line option can be used at a time!
  300.                    The EXACT case must be matched, /R is not /r
  301.  
  302.  
  303.  
  304.  
  305. Multi-Node Systems
  306. ==================
  307.               For Multi-Node systems you must keep a separate set of
  308.          RaCall.DAT, CFG, and USR files in each directory for each line.
  309.          RaCall itself is best put in the System directory.  It should
  310.          be setup something like this in your batch file:
  311.  
  312.          cd\RA\LINE1
  313.          rem  Load RaCall from System dir using files in \ra\line1
  314.          C:\RA\RACALL
  315.          cd\RA\LINE2
  316.          rem  Load RaCall from System dir using files in \ra\line2
  317.          C:\RA\RACALL
  318.  
  319.          Be sure the output paths for the display files are not the same,
  320.          or the stats for line1 with be wrote over but the stats for line2.
  321.          ** RaCall needs only be registered once per board unless a
  322.          different name is to be used on different lines.  As many
  323.          nodes can use the same PassKey as long as they are all the
  324.          exact same name running on one machine.
  325.          ** More then one machine or bbs name are to be registered
  326.          separately.
  327. Notes:
  328. ------
  329.     **   ALT in the "Who Called" bulletin is when a caller is logged
  330.          off by Sysop with ALT-H or ALT-L.
  331.  
  332.     **   Log speeds over 2400bps handled, but only displayed if found
  333.          so 2400 system don't have to look at empty stats for 4800 to 38Kbps!
  334.  
  335.     **   RACALL comes with no warranty of any kind, no responsibility
  336.          or liability is taken for RACALL's use or it actions.
  337.  
  338.     **   RACALL has been tested on RemoteAccess v1.01+ and works fine it.
  339.  
  340.     **   RACALL does NOT write to any RemoteAccess files, except the
  341.          Ra.Log in some cases, otherwise it only writes to it's own
  342.          support files and the text/ANSI output files.
  343.  
  344.     **   RACALL may not work with older versions of RA!
  345.          (but who would want to run an old version??:-)
  346.  
  347.     **   Two options for converting FrontDoor style logs made by doors
  348.          to OPUS format!
  349.  
  350.     **   Opus or FrontDoor style log are handled automaticly.
  351.  
  352.     **   FileDoor (QBBS style) UL/DL log entries supported.
  353.  
  354.     **   XRS (v2.00) and MkXRS (v1.03) log entries supported.
  355.  
  356.     **   XRS name is used by permission of Mike Ratledge (1:1/112)
  357.          I've found the XRS OffLine Mail reader system to be the best
  358.          around, that's why I've added support for it in RaCall.
  359.          If you haven't tried it, I highly suggest and recommend you try it!
  360.  
  361.     **   New versions will come out as RA (and XRS) itself advances
  362.          (and for bug fixes).
  363.  
  364.          Any questions can be addressed to:
  365.  
  366.          Kent Timm
  367.          The Holo-Deck   1:250/728 [FIDO-Net]
  368.  
  369.          Please Note: At this time there is no phone number for my system,
  370.          (couldn't keep up with the phone bill), please route NetMail
  371.          to my thru 1:250/701.
  372.          You can put this in you control files to handle the routing.
  373.          Eg: Binkley/oMMM route :  StuffCM 1:250/701 1:250/728
  374.              FrontDoor Route.ctl:    route 1:250/701 1:250/728
  375.  
  376.          or at the mailing address.  Registered and Registering users
  377.          will get the fastest answers.
  378.  
  379.  
  380. Versions:
  381. =========
  382.  
  383.          v0.00     -First draft, converted from QCall v2.65
  384.  
  385.          v1.00     -Official release of RaCall.
  386.                    -Log speeds above 2400 bps handled, (only displayed
  387.                    if found.)
  388.  
  389.          v1.10     -Fixes the Dropped Carrier listing if user left a
  390.                    leaves message from a menu with /L option.
  391.                    -Built in configuring program added [RACALL /c]
  392.                    -DOCs get a facelift.
  393.                    -Rename log option added.
  394.                    -Reset TOP USERS and DATA command line options added.
  395.                    -Reformat FrontDoor style logs from doors to OPUS style
  396.                     logs.
  397.  
  398.           v1.20    -Frontdoor logs now handled automaticly.
  399.                    -Improved date check with date markers at beginning of log.
  400.                    -Create new log with date marker commandline when not
  401.                     using /r switch. /r creates a date marker after renaming
  402.                     the old log.
  403.                    -FileDoor Upload/Download added.
  404.                    -Message area name can now be displayed instead of just
  405.                     the area number.
  406.                    -8th bit character can be switch off in ASCII (non-color)
  407.                     bulletins.
  408.                    -New Style RaCall.CFG file. Never edit it without using
  409.                     RaCall's config option. (RACALL /c)
  410.                    -Top Users lists from either logs or Users.Bbs.
  411.                    -Door exceptions: Skip shells/exits of non-doors.
  412.  
  413.          v1.22     -Small bug fix.  No other changes.
  414.  
  415.          v1.30     -XRS and MkXRS support added.
  416.                    -Top Users lists can be disabled
  417.                    -Mixxed logs supported.  Sometimes FD logs get in with
  418.                     OPUS and RACall locks in FD, it will now switch back to
  419.                     OPUS the next time an OPUS entry is found.
  420.  
  421.          v1.31     -Use percentage per day fixxed.
  422.  
  423.          v1.32     -Path problems for non-MultiLine systems fixxed.
  424.  
  425.          v1.33     -XRS support updated for XRDOR v1.44
  426.  
  427.          v1.35     -A couple of bugs fixxed.
  428.                    -ANSI bulletin colors changed slightly.
  429.                    -Built-in order form fixxed (/FORM)
  430.                    -XRS local SysOp exports are now counted as mail
  431.                     bags IF SysOp is to be displayed in RA user lists.
  432.